/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.lucene.spatial.distance;

import org.apache.lucene.spatial.geometry.Point;

/**
 * LocationDataSet is an abstracts away the format of the data that defines the location of a document.  It means that
 * different formats can be used, whether they be 2 fields for latitude and longitude, or 1 field with a geohash, without
 * having to change the code that uses the data.
 */
public interface LocationDataSet {

  /**
   * Returns the point (defined by an x/y coordinate) of the document with the given id
   *
   * @param docId ID of the document whose point is to be returned
   * @return Point (defined by an x/y coordinate) of the document with the given id
   */
  Point getPoint(int docId);
}
